<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Simple Data Set Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">SimpleDataSet Element</p>
<h1>Element Overview</h1>
<div class="section-text">
The data set element represents a result set retrieved 
from an external data provider.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Simple Data Set</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>XML Element:</td>
<td><code>None</code></td></tr>
<tr><td>Extends:</td>
<td><a href="DataSet.html">DataSet</a></td></tr>
<tr><td>Extendable:</td>
<td>No</td></tr>
<tr><td>Abstract:</td>
<td>Yes</td></tr>
<tr><td>Name Space:</td>
<td>Data Sets</td></tr>
<tr><td>Name Requirement:</td>
<td>Required</td></tr>
<tr><td>Allows User Properties:</td>
<td>Yes</td></tr>
<tr><td>Has Style:</td>
<td>No</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-dataSetRowLimit">dataSetRowLimit</a></dt>
<dd>Number of rows that will be cached when the data rows are retrieved from DB.</dd>
<dt><a href="#Property-paramBindings">paramBindings</a></dt>
<dd>A list of data set parameter binding elements that bind data set input parameters to BIRT expressions.</dd>
<dt><a href="#Property-refTemplateParameter">refTemplateParameter</a></dt>
<dd>Name of the template parameter definition.</dd>
</dl>

<h3>Method Summary</h3>

<dl class="section-text">
<dt><a href="#Method-afterClose">afterClose</a></dt>
<dd>Called just after BIRT closes the data set. Allows 
the application to perform code-based cleanup.</dd>
<dt><a href="#Method-afterOpen">afterOpen</a></dt>
<dd>Called just after BIRT opens the data set. Allows the 
application to perform any code-based initialization required for the data set.</dd>
<dt><a href="#Method-beforeClose">beforeClose</a></dt>
<dd>Called just before BIRT closes the data set. Allows 
the application to perform code-based cleanup.</dd>
<dt><a href="#Method-beforeOpen">beforeOpen</a></dt>
<dd>Called just before BIRT opens the data set. Allows 
the application to customize the data set properties.</dd>
<dt><a href="#Method-onFetch">onFetch</a></dt>
<dd>Called just after fetching each row before applying 
filters or calculating computed columns.</dd>
</dl>

<h3>Inherited Properties</h3>

<p class="section-text">
<a href="DataSet.html#Property-cachedMetaData">cachedMetaData</a>, 
<a href="DataSet.html#Property-columnHints">columnHints</a>, 
<a href="ReportElement.html#Property-comments">comments</a>, 
<a href="DataSet.html#Property-computedColumns">computedColumns</a>, 
<a href="DesignElement.html#Property-customXml">customXml</a>, 
<a href="ReportElement.html#Property-displayName">displayName</a>, 
<a href="ReportElement.html#Property-displayNameID">displayNameID</a>, 
<a href="ReportElement.html#Property-eventHandlerClass">eventHandlerClass</a>, 
<a href="ReportElement.html#Property-extends">extends</a>, 
<a href="DataSet.html#Property-filter">filter</a>, 
<a href="ReportElement.html#Property-name">name</a>, 
<a href="DataSet.html#Property-needsCache">needsCache</a>, 
<a href="ReportElement.html#Property-newHandlerOnEachEvent">newHandlerOnEachEvent</a>, 
<a href="DataSet.html#Property-parameters">parameters</a>, 
<a href="DesignElement.html#Property-propertyMasks">propertyMasks</a>, 
<a href="DataSet.html#Property-resultSetHints">resultSetHints</a>, 
<a href="DataSet.html#Property-rowFetchLimit">rowFetchLimit</a>, 
<a href="DataSet.html#Property-sortHints">sortHints</a>, 
<a href="DesignElement.html#Property-userProperties">userProperties</a>, 
<a href="ReportElement.html#Property-viewAction">viewAction</a>
</p>
<h3>Inherited Property Notes</h3>

<dl class="section-text">
<dt><a href="ReportElement.html#Property-name">name</a></dt>
<dd>The name is required to identify a data set.</dd>
</dl>

<h3>Description</h3>

<div class="section-text">
<p>The Data Set element is an abstract element that includes 
data-access and report-related properties and other content common to all kinds 
of data sets. </p>

<p>Its script methods execute as methods of a JavaScript 
object that represents the data set. See the Data Scripting Objects section for 
a description of the <code>DataSet</code> 
scripting object.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>DataSet</span> scripting object</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-dataSetRowLimit">dataSetRowLimit Property</a></h2>

<p class="section-text">Number of rows that will be cached when the data rows are retrieved from DB.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#integer">integer</a></td></tr>
<tr><td>Since:</td>
<td>2.2</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Data set row limit</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Number of rows that will be cached when the data rows are first time retrieved from DB, 
the cached data will be used after that unless user choose to flush the cache. This will 
speed up the report developing.</p></div>

<hr>
<h2><a name="Property-paramBindings">paramBindings Property</a></h2>

<p class="section-text">A list of data set parameter binding elements that bind data set input parameters to BIRT expressions.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/ParamBinding.html">ParamBinding</a> Structures</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Parameter bindings</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>A list of data set parameter binding elements that bind 
data set input parameters to BIRT expressions.&nbsp; Each ParamBinding structure 
associates a parameter name with an expression. </p>

<p>BIRT differentiates between data set parameters and 
report parameters. Data set input parameters are not automatically exposed as 
report parameters. However, the report developer can define report parameters 
that match data set input parameters. In this case, data set input parameter 
binding associates data set input parameters with the values of report 
parameters.</p>

<p>The Data Set element provides a list of parameter binding 
elements that bind a value to each query parameter. </p>

<p>The bind expression frequently includes a reference to a 
report parameter, configuration variable, or a row in an outer query. However, 
the expression can include any valid JavaScript expression.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>ParamBinding</span> structure</p>
<p>Report Item <code>paramBindings</code> property</p></div>

<hr>
<h2><a name="Property-refTemplateParameter">refTemplateParameter Property</a></h2>

<p class="section-text">Name of the template parameter definition.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../elements/TemplateParameterDefinition.html">TemplateParameterDefinition</a> Reference</td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Referred Template Parameter Definition</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>when a data set is created from an <i>template data set</i>,
this property will reference to the base data set. </p></div>
<h1>Method Detail</h1>

<h2><a name="Method-afterClose">afterClose Method</a></h2>

<p class="section-text">Called just after BIRT closes the data set. Allows 
the application to perform code-based cleanup.</p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.afterClose(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Context:</td>
<td>factory</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Called just after BIRT closes the data set. Allows the 
application to perform code-based cleanup.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>beforeClose</code> method</p></div>

<hr>
<h2><a name="Method-afterOpen">afterOpen Method</a></h2>

<p class="section-text">Called just after BIRT opens the data set. Allows the 
application to perform any code-based initialization required for the data set.</p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.afterOpen(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Context:</td>
<td>factory</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Called just after BIRT opens the data set. Allows the 
application to perform any code-based initialization required for the data set.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>beforeOpen</code> method</p></div>

<hr>
<h2><a name="Method-beforeClose">beforeClose Method</a></h2>

<p class="section-text">Called just before BIRT closes the data set. Allows 
the application to perform code-based cleanup.</p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.beforeClose(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Context:</td>
<td>factory</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Called just before BIRT closes the data set. Allows the 
application to perform code-based cleanup.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>afterClose</code> method</p></div>

<hr>
<h2><a name="Method-beforeOpen">beforeOpen Method</a></h2>

<p class="section-text">Called just before BIRT opens the data set. Allows 
the application to customize the data set properties.</p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.beforeOpen(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Context:</td>
<td>factory</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Called just before BIRT opens the data set. Allows the 
application to customize the data set properties.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>afterOpen</code> method</p></div>

<hr>
<h2><a name="Method-onFetch">onFetch Method</a></h2>

<p class="section-text">Called just after fetching each row before applying 
filters or calculating computed columns.</p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.onFetch(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Context:</td>
<td>factory</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Called just after fetching each row before applying 
filters or calculating computed columns.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>DataRow</code> scripting object</p></div>
</body>
</html>
